home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / maxbank2.zip / MAXBANK.DOC < prev    next >
Text File  |  1992-01-01  |  14KB  |  325 lines
  1.                                                     page 1
  2.                           MaxBank v2.00
  3.  
  4.           P R O G R A M      D O C U M E N T A T I O N 
  5.  
  6.        MaxBank v2.00 has been programmed by Brian Bourne 
  7.  
  8.                                CONTENTS 
  9.                                                                   
  10.                                                       PAGE 
  11.      1. Copyright Notice . . . . . . . . . . . . . . . 1
  12.  
  13.      2. About MaxBank. . . . . . . . . . . . . . . . . 2
  14.            A. Credits and Thank You's. . . . . . . . . 2
  15.            B. Where it came from . . . . . . . . . . . 2
  16.            C. What it will do for you. . . . . . . . . 2
  17.            D. System Requirements. . . . . . . . . . . 2
  18.  
  19.      3. Installation . . . . . . . . . . . . . . . . . 3
  20.            A. Getting Started With MaxBank . . . . . . 3
  21.            B. Creating Necessary Data Files. . . . . . 3
  22.            C. Loading it from Maximus. . . . . . . . . 3-4
  23.  
  24.      4. Multi-Node BBS's . . . . . . . . . . . . . . . 4-5
  25.  
  26.      5. Problem Solving. . . . . . . . . . . . . . . . 5
  27.            A. Error Codes. . . . . . . . . . . . . . . 5
  28.            B. Other Errors . . . . . . . . . . . . . . 5
  29.  
  30.      5. SysOp Functions. . . . . . . . . . . . . . . . 6
  31.      
  32.      6. Disclaimer . . . . . . . . . . . . . . . . . . 6
  33.       
  34.      7. Contacting the Author. . . . . . . . . . . . . 6
  35.  
  36.  
  37.                         COPYRIGHT NOTICE
  38.  
  39. COPYRIGHT NOTICE:  This program MaxBank v2.00 is 
  40.    Copyright (c)1991 Brian Bourne, and may not be altered, in     
  41.    whole or in part without the written consent of Brian Bourne   
  42.    This applies in Canada, or in any country that is a part of    
  43.    the Berne Copyright Convention, or any country that is a part  
  44.    of the Universal Copyright Convention. 
  45.     
  46.    Brian Bourne hereby gives consent to any and all users to      
  47.    copy MaxBankest at will, conforming to the       
  48.    following criteria: 
  49.    
  50.  1) The file MAXBANK2.ZIP may be distributed freely by any 
  51.     person or agency, so long as no funds are received for        
  52.     profit.  
  53.     Charges for Media costs is allowable. 
  54.            
  55. 2) The file MAXBANK2.ZIP must be distributed in it's whole and 
  56.    original form:  any changes, additions or deletions, in whole  
  57.    or in part of this or any of the accompanying files is a       
  58.    breach of this copyright agreement.  The only changes allowed  
  59.    to this ZIP file is the addition or deletion of the ZIP file   
  60.     comment.  Any other modification to the distribution ZIP file 
  61.     is a breach of this copyright agreement. 
  62.            
  63.    Any person violating this copyright agreement is subject to    
  64.    punishment as prescribed by local copyright laws. 
  65.  
  66.  
  67.                                                     page 2
  68.                          ABOUT MAXBANK 
  69.  
  70.            A. Credits and the Appropriate Thank You's 
  71.  
  72.      First of all I would like to thank Scott Dudley, not only
  73. for his excellent work in producing Maximus v2.00 but also for
  74. providing me with the format of his LASTUS??.BBS files and
  75. helping me decide which are the best way to have the timebank
  76. interact with Maximus.  Thanks Scott.
  77.  
  78.      Peter Avgerinos, who applied incessant pressure and kept me
  79. working on MaxBank even though it was the last thing I wanted to
  80. do.  Peter also beta tested the pre-release of MaxBank and helped
  81. me work out the numerous bugs.  Thanks Pete.
  82.   
  83.                    B. Where MaxBank Came From
  84.  
  85.      After downloading a copy of Maximus CBCS v2.00 and
  86. installing it, I found that many of my favourite utilities didn't
  87. work.  One of those utilities was the timebank that my users
  88. loved so much.  After about 5 trillion messages asking for a new
  89. timebank I set down to write one.  Once I had gotten all the
  90. formats for the new Maximus from Scott Dudley, I set down to
  91. write the timebank.  MaxBank was written as fast as my little
  92. fingers could type.  Many of the communication routines I took
  93. off the online game I am working on.  This speeded things up
  94. considerably but MaxBank still ended up to be more hours of work
  95. than I expected (sigh).  
  96.  
  97.                 C. What MaxBank will do for You!
  98.  
  99.      MaxBank provides your users with a good way to get that
  100. extra online time that they are ALWAYS asking for.  For instance,
  101. since my system is very, very busy I can only allow users 45
  102. minutes per day.  Many users want/need more time to do larger
  103. downloads, etc.  MaxBank can store and give them this extra time. 
  104. You will find that MaxBank becomes very popular by your users.
  105.  
  106.                      D. System Requirements
  107.  
  108. To run MaxBank your system must have the following features
  109. (minimum) to run:
  110.  
  111. - PC/XT/AT/286/386/486
  112. - 640k RAM (recommend) (MaxBank only uses about 50-70k on a shell)
  113. - harddisk
  114. - Maximus CBCS v2.00 (running)
  115. - Monochrome or colour monitor 
  116. - MS-DOS v3.3 or higher
  117. - modem hooked up to either com port 1,2,3 or 4 (high speeds supported)
  118.  
  119. NB. MaxBank has been tested on a 486-33, 286-12 and a 386-33 on both
  120. single and multi-node systems and under DesqView
  121.  
  122.  
  123.                                                     page 3
  124.                            Installation
  125.  
  126.                  A. Getting Started with MaxBank
  127.      
  128.      It is suggested that you unZIP MaxBank into main Maximus
  129. directory.  After installation there will only be 5 files related
  130. to MaxBank, so you won't have to worry about the directory being
  131. over run.  After you unZIP MaxBank the first thing to do is to
  132. edit the configuration file.  I will not repeat the information
  133. in the configuration file.  Simply edit the maxbank.cfg file with
  134. a standard ASCII editor.  The comments in the config file explain
  135. everything.  Please make sure the KEYWORD is flushed left to
  136. column 1 and the there is only one space between the keyword and
  137. the OPTION.  Make sure that all directories specified DO actually
  138. exist.  MaxBank will not create any directories.  THE CONFIGURATION
  139. FILE MUST BE EDITTED BEFORE MAXBANK IS RUN AT ALL!
  140.  
  141. If you wish to ever start MaxBank from scratch simple delete
  142. MAXBANK.USR and MAXBANK.HDR and all accounts will be deleted and
  143. everything will be restarted.
  144.  
  145.                 B. Creating Necessary Data Files
  146.  
  147.     After you start up MaxBank it will create 2 files... MAXBANK.USR and
  148. MAXBANK.HDR. Please do not try to edit these files in any way other
  149. than through the built in MaxBank SysOp editor.  The USR file is the
  150. complete user file containing all information pertaining to the
  151. patrons and the HDR file simple indicates the number of accounts
  152. open.  In the previous beta version the user file length was fixed
  153. and it was necessary to create it, this is not so any more.  MaxBank
  154. is now memory/disk space wise and uses only what space it needs.
  155.  
  156.  
  157.                  C. Loading MaxBank from Maximus 
  158.  
  159.      The best way to run MaxBank is to create a mecca file in
  160. your MISC directory.  The MECCA file should look something like
  161. this:
  162. -----------------------------------------------------------------
  163. Loading MaxBank...
  164.  
  165. [xtern_run]@c:\max\maxbank.exe /com%P
  166.  
  167. -----------------------------------------------------------------
  168.  
  169. If you are running a multinode system you should read the section on
  170. MultiNode configuration before compiling, your MECCA will be slightly
  171. different.
  172. You can then compile your mecca file.  Just so you understand
  173. what you just did.  
  174.   [xtern_run] - well this is kind of obvious, it simple runs an
  175.                external program!
  176.   @c:\max\maxbank.exe - this is not so obvious.  The @ sign tells
  177.                Maximus to "ReRead" the LASTUS??.BBS file to get
  178.                the new amount of time remaining online.  The rest
  179.                is simply your path and file name for MaxBank.exe
  180.   /com%P - this is the command line parameter than MaxBank
  181.                requires to run.  MaxBank will open up at whatever
  182.                the current baud rate is.  The %P tells maximus to
  183.                pass the com port (eg: COM1 = 1)
  184.  
  185.                                                     page 4
  186.      The next step you will have to perform is to go into and
  187. edit your MENUS.CTL file in your Maximus directory.  You can
  188. simply insert this line (or your specific variation of) on which
  189. ever menu you like...
  190. ----------------------------------------------------------------
  191.      Display_File    Misc\MaxBank       Normal "$MaxBank"
  192. ----------------------------------------------------------------
  193.  
  194.      That's it! Now compile your new control file using SILT.EXE
  195. and presto! MaxBank is installed.  Multinode BBS SysOp's should
  196. read on however.
  197.  
  198.                        D. MultiNode BBS's
  199.  
  200. Well, configuration for MultiNode BBS's is actually very simple.  The
  201. configuration file remains unchanged with the keyword "LASTUSER"
  202. pointing to the full path to the lastus??.bbs file(s).  The only
  203. change a multinode system must make over a single node system is that
  204. following change in the MECCA file, it should look like this
  205. -----------------------------------------------------------------
  206. Loading MaxBank...
  207.  
  208. [xtern_run]@c:\max\maxbank.exe /com%P /t%K
  209.  
  210. -----------------------------------------------------------------
  211. Please make sure that the "%K" is capitalized.  That is all.  MaxBank
  212. will now load the appropriate Lastuser file according to the task
  213. number.  
  214.  
  215.  
  216.                                                     page 5
  217.                          Problem Solving
  218.  
  219.                          A. Error Codes
  220.  
  221. The following are error numbers which MaxBank will write to the
  222. log file if they occur.
  223.  
  224.  
  225. CODE |        ERROR            |     SOLUTION 
  226. -------------------------------+-----------------------
  227.  14  | Out of String Space     | Allow MaxBank more memory!
  228.  51  | Internal Error          | Hardware Problem not related to
  229.      |                         | MaxBank
  230.  53  | File not Found          | Means one of MaxBank's files  
  231.      |                         | are not present.  Check
  232.      |                         | for lastuser.bbs, etc.
  233.  57  | Device I/O Error        | DOS error concerning I/O        
  234.      |                         | functions
  235.  61  | Disk Full               | Make more room on the drive.
  236.  67  | Too many files          | Specify more files in your       
  237.      |                         | Config.Sys
  238.  68  | Device Unavailable      | COM port specified doesn't exist 
  239.  69  | Communication buffer    | Rare Error.  Contact Author.
  240.      |                 overflow|                            
  241.  70  | Disk Write Protected    | Remove write protection
  242.  71  | Disk Not Ready          | If you are using floppy disks, 
  243.      |                         | insert 1
  244.  72  | Disk Media Error        | Disk is damaged. Hardware   
  245.      |                         | problem
  246.  75  | Path/File Access Error  | Create the path / re-specify in
  247.      |                         | cfg file.
  248.  76  | DeadLock                | On multi-node systems. One of 
  249.      |                         | the files is being access by     
  250.      |                         | both nodes at once (or the same
  251.      |                         | record within the user file)
  252.      |                         | - simply re-enter MaxBank
  253.  
  254. If any other errors occur, contact author immediately.
  255.  
  256.                          B. Other Errors
  257.  
  258.      Not very many errors SHOULD occur.  But run down this
  259. checklist if no error number is reported by MaxBank.
  260.  
  261. - the lastuser.bbs file is NOT corrupt (it should be 240 bytes)
  262. - that the lastuser path in the configuration file ends with a backslash
  263. - you HAVE run MaxBank with the /INIT option to create the        
  264.   necessary data files.
  265. - check your configuration file to make sure all paths specified  
  266.   actually exist.
  267. - you have followed the installation procedures as outlined in    
  268.   this documentation (letter for letter)
  269. - make sure that MAXBANK.CFG is in the same directory as MaxBank and
  270.   MaxBank has been run from the directory that it is in
  271. - if you are under a multi-tasker, was there a SHARE violation
  272.  
  273. If you everything still seems to be ok then it is time to get
  274. some extra help.  Contact the author.
  275.  
  276.  
  277.                                                     page 6
  278.                         SysOp Functions
  279.  
  280.      While a user is online the SysOp may use the following keys:
  281.  
  282.      F10 (function key 10) - Break into Chat
  283.      F5  (function key 5)  - Exit MaxBank immediately
  284.      F6  (function key 6)  - Shell to DOS
  285.  
  286.      These are the only "local sysop" only commands.  All other commands I
  287. feel are self-explanatory and need no further documentation.
  288.  
  289.                            Disclaimer
  290.  
  291.      I'll try to keep this brief:
  292.  
  293.      THE AUTHOR, NOR ANYONE ASSOCIATED WITH, IS NOT RESPONSIBLE
  294.      IN ANY WAY FOR DAMAGES, WHETHER PERSONAL OR TO YOUR
  295.      BELONGINGS.  MAXBANK IS PROVIDED AS IS.  THERE ARE NO
  296.      GUARANTEES.  THE AUTHOR, NOR ANYONE ASSOCIATED WITH, ARE
  297.      RESPONSIBLE FOR ANY DAMAGES INCURRED BY MODIFIED COPIES OF
  298.      MAXBANK.  
  299.  
  300.                       Contacting the Author
  301.  
  302.      Please feel free to contact the author at any time to
  303. express compliments, complaints, concerns, report bugs, offer
  304. suggestions, etc.  
  305.  
  306.      Brian Bourne may be contacted at the following addresses:
  307.  
  308.      Electronic Addresses:
  309.           FIDO-Net          1:250/722
  310.           BBS               416-225-8942 (2400 bps)
  311.                             (Super SONIC BBS)
  312.  
  313.      Surface Mail:
  314.           Brian Bourne
  315.           100 Park Home Ave.
  316.           Willowdale, Ontario
  317.           Canada
  318.           M2N-1W8
  319.  
  320.      NB: If you choose to send surface mail, please be sure to
  321.      include a self-addressed, stamped envelope.
  322.  
  323.  
  324. 
  325.